home *** CD-ROM | disk | FTP | other *** search
/ Turnbull China Bikeride / Turnbull China Bikeride - Disc 1.iso / ARGONET / PD / FILER / PACK.ZIP / !PackDisc / Readme < prev    next >
Text File  |  1996-06-18  |  8KB  |  172 lines
  1. Help file for PackDisc 0.05
  2. ===========================
  3.  
  4. Overview
  5. --------
  6.  
  7. This program will increase the free space on any FileCore based filing
  8. system. This free space which is created comes from the wasted space in
  9. shared fragments. !PackDisc rearranges which files share fragments with each
  10. other in such a way as to minimise the remaining wasted space.
  11.  
  12. PackDisc is ideal on directories which have constant contents and several
  13. small files, for example application directories, as the small files can be
  14. rearranged more effectively and the space saved should remain saved.
  15. It may also be useful for PD libraries or magazine discs or anyone else who
  16. wants to use every last sector on a floppy - it can usually save at least a
  17. couple of KB from a typical floppy. I saved 11K on a copy of the RISC OS 3
  18. App1 disc. On my whole hard drive I saved about 10MB.
  19.  
  20. The whole of the re-arrangement is done using high-level filing system calls
  21. to minimise the risk of corrupting discs. However, the FileCore bug which
  22. can corrupt nearly-full discs *could* rear its ugly head. I have not had any
  23. problems with the current version. An early development version *did* cause
  24. a corruption of a couple of very large files but these are handled
  25. differently now so the corruption should not occur.
  26.  
  27.  
  28. Usage
  29. -----
  30.  
  31. Before running this program on a disc you should make sure it has enough
  32. free space on it for PackDisc to operate. If necessary move a large file off
  33. the disc and replace it afterwards. I would recommend having at least 1MB
  34. of free space on a hard drive and about 30K on a floppy. It is probably
  35. possible to do it with less.
  36.  
  37. If you use FSLock, you will either need to edit the !RunImage and change the
  38. names of the temporary directories «Scratch» and «STORE» to a writable
  39. location on the disc or disable it while PackDisc is running.
  40.  
  41. Either double click on the icon to run it single tasking, or shift-drag it
  42. to a TaskWindow.
  43.  
  44. Enter the filename of the directory you want to optimise. This *must* be a
  45. full path including the FS and disc name/drive number, and must be on a
  46. filecore based filing system. You should not attempt to optimise any of the
  47. parent directories of the temp directories, or directories in image files.
  48.  
  49. You may either optimise just the directory stated, or recurse into all its
  50. subdirectories as well.
  51.  
  52. The Verbosity level is set near the start of the program. This will determine
  53. how much output is given.
  54.  
  55. Level 0  Gives only the space saved statistics for the whole run of the program
  56.          when it finishes.
  57. Level 1  Also gives you the space saved statistics for each directory.
  58. Level 2  Tells you what overall operation it is trying to acheive at each step.
  59. Level 3  Tells you as it moves each file and gives a breakdown of the groups.
  60. Level 4  Gives some information on how the grouping is being derived.
  61.  
  62. After a while the program should terminate, telling you how much space the
  63. files take (rounded to sectors), how much wasted space was recovered as free
  64. space, and how much wasted space remains. This often shows that about a third
  65. of the original wasted space was recovered, but depends very much on how many
  66. relatively small files there are in the directories optimised.
  67.  
  68. There is no point running it more than once on the same directory as no further
  69. space can be saved (at least not with this program)
  70.  
  71. IMPORTANT: do not run *ANY* other program which could possibly write to the
  72. disc and alter the amount of free space at the same time as PackDisc. At best
  73. it will cause PackDisc to report the space saved incorrectly, but it will
  74. probably make it bomb out with an error.
  75.  
  76. Utilities such as LongFiles or SymLinks will cause problems, so should be
  77. disabled before running - I would recommend running on a cleanly restarted
  78. machine without running the boot sequence (hold down <shift> while
  79. restarting).  PackDisc will complain if it comes across a filename of more
  80. than 10 characters to try to prevent some of these problems.
  81.  
  82. If an error does occur, don't worry, none of your files will be lost. Any
  83. files or directories which appear to be missing are in PackDisc's store
  84. directory. This is $.«STORE» on the disc you are optimising unless you have
  85. amended the program to get round FSLock. PackDisc will tell you which
  86. directory the contents of the store should be moved to when it exits.
  87.  
  88. During the course of its normal operation, PackDisc will create several
  89. directories which fsck describes as "Directories bigger than the minimum
  90. size". This is nothing to worry about - it is allowing more files to share
  91. the same fragment with the directory.
  92.  
  93. Another way that you can create more space on a hard disc is to reduce its
  94. size. If you have a disc formatted to a value between about 500MB and 512MB
  95. or so, and the LFAU is 2K, reducing it to just less than 500MB so that the
  96. LFAU is only 1K and putting all the files back on will probably halve the
  97. wasted space. I had over 40MB of wasted space on my disc at 511.8M,
  98. reformatting it to about 499.5M reduced this to about 20M representing an
  99. overall saving of nearly 10M. There is another boundary size for the .5K to
  100. 1K LFAU transition but I don't know what this is.
  101.  
  102.  
  103. DISCLAIMER
  104. ----------
  105.  
  106. While every effort has been taken to ensure that files do not get lost or
  107. corrupted, I WILL NOT BE HELD RESPONSIBLE for any loss that occurs as a
  108. direct or indirect result of using this program. It is up to you to make sure
  109. any important data is adequately backed up, and irrespomsible not to do so.
  110. [I guess that makes *me* irresponsible... oh well 8-]
  111.  
  112. Having said that, I would like to know if there is a problem with the
  113. program, especially if you can see where it needs fixing.
  114.  
  115.  
  116. Shortcomings of this version
  117. ----------------------------
  118.  
  119.   - Single tasking (although it can be run in a taskwindow). Options
  120.     (ie the display output level and names of temp directories) are changed
  121.     by editing a line in the program code.
  122.   - Uses far too many file operations. This makes it rather slow. A version
  123.     using lower level operations would be able to go a lot faster.
  124.   - Will not work if any other program is accessing the disc at the same time
  125.     (or rather writing to it).
  126.   - Does not cope gracefully with errors. The user must replace files which
  127.     are stuck in its temp directory and delete any files in its scratch area.
  128.     Having said that, error do not occur in my experience unless another
  129.     program accesses the disc at the same time or there was too little free
  130.     disc space.
  131.   - Cannot check potential savings without first doing it. This makes for
  132.     lots of tedious copying which may not free any space.
  133.   - Can cause the free space map to become very fragmented during the course
  134.     of normal operation. This can be partially alleviated by a *Compact.
  135.   - Is slowed down considerably by a very fragmented free space map. This
  136.     and the one above do not work together very well...
  137.   - The optimisation algorithm is not perfect and sometimes gives
  138.     sub-optimal arrangements. Indeed I have seen negative savings
  139.     occasionally.
  140.   - Has not yet been tested on the new FileCore, although there is no reason
  141.     why it shouldn't work.
  142.  
  143. If you have any problems mail me (although the Email address is only valid
  144. until the end of the month)
  145.  
  146.  
  147. The Author
  148. ----------
  149.  
  150. PackDisc was written by Steve Lee. If you would like to receive an updated
  151. version after I have made it MultiTask, send a disc and an SAE to the address
  152. below - I don't know if I'll be able to get net access after I leave uni.
  153.  
  154. If you fancy sending any money too I'm sure I'd love it 8-)
  155. Might even encourage me to redo it with less kludges and a better
  156. algorithm...
  157.  
  158. My home address is:
  159.  
  160. Steve Lee
  161. 114 Cherington Rd.
  162. Selly Park
  163. Birmingham
  164. B29 7SR
  165. England
  166.  
  167. Until the end of June 96:
  168.  
  169. my Email address is sml1007@cam.ac.uk
  170. website at http://sml1007.robinson.cam.ac.uk/~sml1007/
  171.  
  172. (I guess you'll have to be quick to use either of these though :-)